////////////////////////////////////////////////////////////////////////////////
//Copyright (c) 2010 Michal Szczepanski - (http://vane.pl)
//
//Permission is hereby granted, free of charge, to any person obtaining a copy
//of this software and associated documentation files (the "Software"), to deal
//in the Software without restriction, including without limitation the rights
//to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//copies of the Software, and to permit persons to whom the Software is
//furnished to do so, subject to the following conditions:
//
//The above copyright notice and this permission notice shall be included in
//all copies or substantial portions of the Software.
//
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//THE SOFTWARE.
////////////////////////////////////////////////////////////////////////////////
package pl.vane.as3relax
{	
	/**
	 * CouchDocument defines basic CouchDB document
	 * 
	 * @see http://wiki.apache.org/couchdb/HTTP_Document_API
	 * 
	 * @langversion ActionScript 3.0
	 * @playerversion Flash 9.0
	 * @tiptext
	 */ 
	public class CouchDocument implements ICouchDocument
	{
		private var __id:String;
		private var __rev:String;
		
		/**
		 * Constructor.
		 * 
		 * @langversion ActionScript 3.0
		 * @playerversion Flash 9.0
		 * @tiptext
		 */
		public function CouchDocument(id:String = null, rev:String = null) {
			__id = id;
			__rev = rev;
		}
		
		/**
		 * Gets and sets the _id of the CouchDB Document.
		 * 
		 * @langversion ActionScript 3.0
		 * @playerversion Flash 9.0
		 * @tiptext
		 */ 
		public function get _id():String { return __id; }
		public function set _id(value:String):void { __id = value; }
		
		/**
		 * Gets and sets the _rev of the CouchDB Document.
		 * 
		 * @langversion ActionScript 3.0
		 * @playerversion Flash 9.0
		 * @tiptext
		 */ 
		public function get _rev():String { return __rev; }
		public function set _rev(value:String):void { __rev = value; }
		
		/**
		 * Gets the Deleted document JSON <code>String</code>.
		 * 
		 * @langversion ActionScript 3.0
		 * @playerversion Flash 9.0
		 * @tiptext
		 */ 
		public function get deletedJSON():String {
			if(!__rev || !__id)
				return null;
			return '{"id":'+__id+',"_rev":'+__rev+',"_deleted":true}';
		}
		
		/**
		 * Gets the document JSON string.
		 * 
		 * <p>Can simplyfy the request of the document JSON when
		 * overriden in classes that inherits from CouchDocument</p> 
		 * 
		 * @langversion ActionScript 3.0
		 * @playerversion Flash 9.0
		 * @tiptext
		 */ 
		public function get JSONString():String {
			return '{"_id":'+__id+',"_rev":'+__rev+'}';
		}
	}
}
